Description
Fires before a particular screen is loaded. The load-* hook fires in a number of contexts. This hook is for plugin screens where a callback is provided when the screen is registered. The dynamic portion of the hook name, `$page_hook`, refers to a mixture of plugin page information including: 1. The page type. If the plugin page is registered as a submenu page, such as for Settings, the page type would be 'settings'. Otherwise the type is 'toplevel'. 2. A separator of '_page_'. 3. The plugin basename minus the file extension. Together, the three parts form the `$page_hook`. Citing the example above, the hook name used would be 'load-settings_page_pluginbasename'.
Occurrences
Filename | Line Number |
---|---|
wp-admin/admin.php | 237 |
PHP Doc
/**
* Fires before a particular screen is loaded.
*
* The load-* hook fires in a number of contexts. This hook is for plugin screens
* where a callback is provided when the screen is registered.
*
* The dynamic portion of the hook name, `$page_hook`, refers to a mixture of plugin
* page information including:
* 1. The page type. If the plugin page is registered as a submenu page, such as for
* Settings, the page type would be 'settings'. Otherwise the type is 'toplevel'.
* 2. A separator of '_page_'.
* 3. The plugin basename minus the file extension.
*
* Together, the three parts form the `$page_hook`. Citing the example above,
* the hook name used would be 'load-settings_page_pluginbasename'.
*
* @see get_plugin_page_hook()
*
* @since 2.1.0
*/